// ==========================================================================
// GFast自动生成dao internal操作代码。
// 生成日期：2023-12-01 14:49:39
// 生成路径: internal/app/plugins/sms/dao/internal/plugin_sms_config.go
// 生成人：gfast
// desc:短信配置
// company:云南奇讯科技有限公司
// ==========================================================================

package internal

import (
	"context"

	"github.com/gogf/gf/v2/database/gdb"
	"github.com/gogf/gf/v2/frame/g"
)

// PluginSmsConfigDao is the manager for logic model data accessing and custom defined data operations functions management.
type PluginSmsConfigDao struct {
	table   string                 // Table is the underlying table name of the DAO.
	group   string                 // Group is the database configuration group name of current DAO.
	columns PluginSmsConfigColumns // Columns is the short type for Columns, which contains all the column names of Table for convenient usage.
}

// PluginSmsConfigColumns defines and stores column names for table plugin_sms_config.
type PluginSmsConfigColumns struct {
	Id      string // ID
	SmsType string // 短信平台
	Remark  string // 备注
	Status  string // 状态
	Config  string // 配置
}

var pluginSmsConfigColumns = PluginSmsConfigColumns{
	Id:      "id",
	SmsType: "sms_type",
	Remark:  "remark",
	Status:  "status",
	Config:  "config",
}

// NewPluginSmsConfigDao creates and returns a new DAO object for table data access.
func NewPluginSmsConfigDao() *PluginSmsConfigDao {
	return &PluginSmsConfigDao{
		group:   "default",
		table:   "plugin_sms_config",
		columns: pluginSmsConfigColumns,
	}
}

// DB retrieves and returns the underlying raw database management object of current DAO.
func (dao *PluginSmsConfigDao) DB() gdb.DB {
	return g.DB(dao.group)
}

// Table returns the table name of current dao.
func (dao *PluginSmsConfigDao) Table() string {
	return dao.table
}

// Columns returns all column names of current dao.
func (dao *PluginSmsConfigDao) Columns() PluginSmsConfigColumns {
	return dao.columns
}

// Group returns the configuration group name of database of current dao.
func (dao *PluginSmsConfigDao) Group() string {
	return dao.group
}

// Ctx creates and returns the Model for current DAO, It automatically sets the context for current operation.
func (dao *PluginSmsConfigDao) Ctx(ctx context.Context) *gdb.Model {
	return dao.DB().Model(dao.table).Safe().Ctx(ctx)
}

// Transaction wraps the transaction logic using function f.
// It rollbacks the transaction and returns the error from function f if it returns non-nil error.
// It commits the transaction and returns nil if function f returns nil.
//
// Note that, you should not Commit or Rollback the transaction in function f
// as it is automatically handled by this function.
func (dao *PluginSmsConfigDao) Transaction(ctx context.Context, f func(ctx context.Context, tx gdb.TX) error) (err error) {
	return dao.Ctx(ctx).Transaction(ctx, f)
}
